ISWPluginMenu Class Reference
#include <ISWPluginMenu.h>
List of all members.
Detailed Description
This interface is the plugin interface to Action Menu's in in Server Watch. An instance of this interface is passed to the plugin in the CreateMenu function, and the user creates the menu to be displayed using the ISWMenuContext::AddMenuItem function. The plugin can get context information to aid in the creation of the menu through the ISWMenuContext::GetMenuType and ISWMenuContext::GetMenuContext functions. When the menu item is triggered, Server Watch calls the SWMENUACTIONCALLBACK function specified in the fnPtr parameter during the AddMenuItem for that menu item.
Member Typedef Documentation
|
Typedef of the callback function signature used when notifying plugins of a plugin action. The instance of this function type (specificed with the action in AddMenuItem) is called whenever the user has selected an action
After the menu is created with AddMenuItem, the menu is displayed to the user. If the user clicks a menu item then the function associated with the action is executed.
- Parameters:
-
| pThisServer | A SWPluginServerStruct that contains the information related to this server. |
| menuType | The menutype that triggered this action. |
| pMenuContext | The ISWMenuContext of the location that triggered this action. |
- Return values:
-
| SW_OK | Return this if the processing within this function was successful |
| SW_FAIL | Return this if the processing within this function failed |
|
Member Enumeration Documentation
|
Denotes the type of action menu being created or worked with. - Enumeration values:
-
Undefined |
|
AuxStat |
The action was triggered from the Auxiliary status field. |
UserList |
The action was triggered from a cell in the UserList. |
|
Constructor & Destructor Documentation
Member Function Documentation
virtual SWMenuType ISWPluginMenu::GetMenuType |
( |
|
) |
[pure virtual] |
|
|
GetMenuType returns the type of menu being created. Most likely a different set of menu items should be returned for different contexts |
virtual ISWMenuContext* ISWPluginMenu::GetMenuContext |
( |
|
) |
[pure virtual] |
|
|
AddMenuItem is used to add a menu item to the menu to be displayed. Menu items are displayed in the menu in the order they were added to the menu. - Parameters:
-
| strItemName | The text of the menu item. |
| fnPtr | Function pointer to the function to call if this menu item is selected. |
| flags | Bitmask of flags to specify menu properties. |
|
The documentation for this class was generated from the following file: